home *** CD-ROM | disk | FTP | other *** search
/ CU Amiga Super CD-ROM 24 / CU Amiga Magazine's Super CD-ROM 24 (1998)(EMAP Images)(GB)(Track 1 of 2)[!][issue 1998-07].iso / CUCD / Programming / MCC_NList / Developer / AutoDocs / MCC_NFloattext.doc next >
Encoding:
Text File  |  1998-05-04  |  5.5 KB  |  162 lines
  1. TABLE OF CONTENTS
  2.  
  3. NFloattext.mcc/NFloattext.mcc
  4. NFloattext.mcc/MUIA_NFloattext_Align
  5. NFloattext.mcc/MUIA_NFloattext_Justify
  6. NFloattext.mcc/MUIA_NFloattext_SkipChars
  7. NFloattext.mcc/MUIA_NFloattext_TabSize
  8. NFloattext.mcc/MUIA_NFloattext_Text
  9. NFloattext.mcc/MUIM_NFloattext_GetEntry
  10. NFloattext.mcc/NFloattext.mcc
  11.  
  12.         NFloattext class is a subclass of NList class that takes
  13.         a big text string as input and splits it up into several
  14.         lines to be dislayed. Formatting capabilities include
  15.         paragraphs an justified text with word wrap. That MCC
  16.         public custom class  work near the same way as Floattext.
  17.  
  18.         All you can do with NFloattext can be done directly using
  19.         NList and its word wrap capabilities. NFloattext is here
  20.         to give easy use and transition from Floattext.
  21.  
  22.         Now NList package provide a Floattext.mui replacement
  23.         which use directly this class. Unfortunately the
  24.         repacement Floattext.mui have to have the same major release
  25.         number than original Floattext.mui to be accepted by MUI,
  26.         so it will have to be update with each new MUI remease.  :(
  27.  
  28.         By default, MUIA_NList_Input is FALSE and MUIA_NList_TypeSelect
  29.         is MUIV_NList_TypeSelect_Char, alowing char selection and copy
  30.         to clipboard. If you set MUIA_NList_Input to TRUE, then
  31.         MUIA_NList_TypeSelect default to MUIV_NList_TypeSelect_Line as
  32.         usual.
  33.  
  34.         NFloattext don't copy the string text, so it needs to copy
  35.         the string line to a buffer when you do a MUIM_NFloattext_GetEntry
  36.         or MUIM_List_GetEntry, so the return pointer will be invalid
  37.         after next GetEntry call (the new one will be valid of course).
  38.  
  39.         Using the old MUIA_Floattext_Text from standard Floadtext class
  40.         instead of MUIA_NFloattext_Text will make NFloattext copy
  41.         the text like in Floattext class.
  42.  
  43.         Note that MUIM_NList_GetEntry work as describe in NList, so
  44.         as NFloattext use word wrap entries, you should use better
  45.         MUIM_NFloattext_GetEntry or MUIM_List_GetEntry. Or use
  46.         MUIM_NList_GetEntryInfo and MUIM_NList_GetEntry.
  47.  
  48.     Author: Gilles Masson    (c) 1996-1997    email: masson@iut-soph.unice.fr
  49. NFloattext.mcc/MUIA_NFloattext_Align
  50.  
  51.     NAME
  52.         MUIA_NFloattext_Align -- [ISG], LONG
  53.  
  54.     SPECIAL INPUTS
  55.         ALIGN_LEFT
  56.         ALIGN_CENTER
  57.         ALIGN_RIGHT
  58.         ALIGN_JUSTIFY
  59.  
  60.     FUNCTION
  61.         Indicate what alignment you want.
  62.         It can be done with an escape alignment sequence
  63.         in the Format preparse string or in the text string
  64.         (for each linefeed separated lines) itself.
  65.  
  66.         setting it will set MUIA_NFloattext_Justify to
  67.         TRUE if ALIGN_JUSTIFY, else to FALSE.
  68.  
  69.     SEE ALSO
  70.         MUIA_NFloattext_Justify, MUIA_NList_Format
  71. NFloattext.mcc/MUIA_NFloattext_Justify
  72.  
  73.     NAME
  74.         MUIA_NFloattext_Justify -- [ISG], BOOL
  75.  
  76.     FUNCTION
  77.         Same as Floattext.mui/MUIA_Floattext_Justify.
  78.  
  79.         if TRUE, MUIA_NFloattext_Align will be set to
  80.         ALIGN_JUSTIFY, else to ALIGN_LEFT.
  81.  
  82.     SEE ALSO
  83.         MUIA_NFloattext_Align, MUIA_NList_Format
  84. NFloattext.mcc/MUIA_NFloattext_SkipChars
  85.  
  86.     NAME
  87.         MUIA_NFloattext_SkipChars -- [ISG], char *
  88.  
  89.     FUNCTION
  90.         Same as NList.mcc/MUIA_NList_SkipChars
  91.         and Floattext.mui/MUIA_Floattext_SkipChars.
  92.  
  93.     SEE ALSO
  94.         MUIA_NList_SkipChars, MUIA_Floattext_SkipChars
  95. NFloattext.mcc/MUIA_NFloattext_TabSize
  96.  
  97.     NAME
  98.         MUIA_NFloattext_TabSize -- [ISG], LONG
  99.  
  100.     FUNCTION
  101.         Same as NList.mcc/MUIA_NList_TabSize
  102.         and Floattext.mui/MUIA_Floattext_TabSize.
  103.  
  104.         Tab size defaults to 8.
  105.  
  106.     SEE ALSO
  107.         MUIA_NList_TabSize, MUIA_Floattext_TabSize
  108. NFloattext.mcc/MUIA_NFloattext_Text
  109.  
  110.     NAME
  111.         MUIA_NFloattext_Text -- [ISG], STRPTR
  112.  
  113.     FUNCTION
  114.         Same as Floattext.mui/MUIA_Floattext_Text.
  115.  
  116.         String of characters to be displayed as floattext.
  117.         This string may contain linefeeds or carriage retruns to mark
  118.         the end of paragraphs or tab characters for indention.
  119.  
  120.         NFloattext will automatically format the text according
  121.         to the width of the NFloattext object. If a word
  122.         won't fit into the current line, it will be wrapped.
  123.  
  124.         NFloattext don't copies the string into a private buffer
  125.         as Floattext do it, so you need to keep your text in
  126.         memory, but it uses less memory.
  127.  
  128.         If you want NFloattext to copy the text, just use
  129.         MUIA_Floattext_Text which will do it for compatibility.
  130.  
  131.         Setting MUIA_NFloattext_Text to NULL means to clear
  132.         the current text.
  133.  
  134.         Please note that justification and word wrap is a
  135.         complicated operation and may take a considerable
  136.         amount of time, especially with long texts on slow
  137.         machines.
  138.  
  139. NFloattext.mcc/MUIM_NFloattext_GetEntry
  140.  
  141.     NAME
  142.         MUIM_NFloattext_GetEntry --
  143.  
  144.     SYNOPSIS
  145.         DoMethod(obj,MUIM_NFloattext_GetEntry,LONG pos, APTR *entry);
  146.  
  147.     FUNCTION
  148.         Same function as List.mui/MUIM_List_GetEntry.
  149.  
  150.         You'll get pointer to a null terminated string buffer which
  151.         is a copy of the asked visible entry.
  152.  
  153.         Unlike with Floattext, the returned string will be valid only
  154.         until next MUIM_NFloattext_GetEntry/MUIM_List_GetEntry call
  155.         if the entry was word wrapped.
  156.         I'll try to make it stay valid when using MUIM_List_GetEntry
  157.         only if someone report me some compatibility problem because
  158.         doing that will use more memory.
  159.  
  160.     SEE ALSO
  161.         MUIM_NList_GetEntry, MUIM_NList_GetEntryInfo, MUIM_List_GetEntry
  162.